package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AttendanceDedItemAddDTO;
import org.jsola.hr.dto.AttendanceDedItemUpdateDTO;
import org.jsola.hr.query.AttendanceDedItemQuery;
import org.jsola.hr.vo.AttendanceDedItemListVO;
import org.jsola.hr.vo.AttendanceDedItemVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-考勤扣款设置子项")
public interface IAttendanceDedItemControllerAPI {

    /**
     * 新增考勤扣款设置子项
     * @param attendanceDedItemAddDTO 考勤扣款设置子项新增实体
     * @return 考勤扣款设置子项展示对象
     */
    @ApiOperation(value = "新增考勤扣款设置子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedItemAddDTO", dataType = "AttendanceDedItemAddDTO", value = "新增考勤扣款设置子项", paramType = "body")
    })
    Result<AttendanceDedItemVO> save(AttendanceDedItemAddDTO attendanceDedItemAddDTO);


    /**
     * 修改考勤扣款设置子项
     * @param attendanceDedItemUpdateDTO 考勤扣款设置子项
     * @return 更新数量
     */
    @ApiOperation(value = "修改考勤扣款设置子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedItemUpdateDTO", dataType = "AttendanceDedItemUpdateDTO", value = "修改考勤扣款设置子项", paramType = "body")
    })
    Result<Integer> update(AttendanceDedItemUpdateDTO attendanceDedItemUpdateDTO);




    /**
     * 删除单个考勤扣款设置子项，彻底删除
     * @param attendanceDedItemId 考勤扣款设置子项id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个考勤扣款设置子项，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedItemId", dataType = "String", value = "考勤扣款设置子项id", paramType = "path")
    })
    Result<Integer> delete(String attendanceDedItemId);


    /**
     * 批量删除考勤扣款设置子项，彻底删除
     * @param attendanceDedItemIds 考勤扣款设置子项id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除考勤扣款设置子项，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedItemIds", dataType = "String[]", value = "考勤扣款设置子项id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] attendanceDedItemIds);


    /**
     * 根据考勤扣款设置子项id查询考勤扣款设置子项详情
     * @param attendanceDedItemId 考勤扣款设置子项id
     * @return 考勤扣款设置子项详情
     */
    @ApiOperation(value="根据考勤扣款设置子项id查询考勤扣款设置子项详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedItemId", dataType = "String", value = "考勤扣款设置子项id", paramType = "path")
    })
    Result<AttendanceDedItemVO> findById(String attendanceDedItemId);


    /**
     * 查询考勤扣款设置子项
     * @param attendanceDedItemQuery 考勤扣款设置子项查询参数
     * @return page
     */
    @ApiOperation(value="查询考勤扣款设置子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedItemQuery", dataType = "AttendanceDedItemQuery", value = "考勤扣款设置子项查询参数", paramType = "query")
    })
    Result<List<AttendanceDedItemListVO>> listAll(AttendanceDedItemQuery attendanceDedItemQuery);


     /**
     * 分页查询考勤扣款设置子项
     * @param attendanceDedItemQuery 考勤扣款设置子项查询参数
     * @return page
     */
    @ApiOperation(value="分页查询考勤扣款设置子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedItemQuery", dataType = "AttendanceDedItemQuery", value = "考勤扣款设置子项查询参数", paramType = "query")
    })
    Result<Page<AttendanceDedItemListVO>> page(AttendanceDedItemQuery attendanceDedItemQuery);


}

